/*
 * AbstractDocumentManager.java is part of htn-iface.
 *
 * AbstractDocumentManager.java is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * AbstractDocumentManager.java is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with AbstractDocumentManager.java.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.htn.repository;

/**
 * AbstractDocumentManager provides a method that may be used internally by the
 * {@link DocumentManager} implementation to generate an ID that is specified
 * or created by the telescope scheduler.
 * 
 * @param <T>
 */
public abstract class AbstractDocumentManager<T>
implements DocumentManager<T> {
	
	/**
	 * Returns null.  Extenders should implement this method if there
	 * is an ID that is generated by the telescope-specific implementation.
	 * The idea is that the default is the primary ID (PK in db-land) that
	 * is generated by the persistence layer (the implemetation of the
	 * {@link DocumentManager}.
	 * 
	 * This method is protected, and hence only accessible by extensions to
	 * this class.
	 * 
	 * @return null
	 */
	protected String obtainTelescopeSchedulerId() {
		return null;
	}

}
